/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>
#import "OFXTransaction.h"

typedef enum {
  SHARES_UNIT_TYPE,
  CURRENCY_UNIT_TYPE
} OFXInvestmentUnitType;

@interface OFXInvestmentTransaction : OFXTransaction {
  NSString* reversingUniqueId;
  NSString* investment401kSource;
  NSDate* tradeDate;
  NSDate* settlementDate;
}

/**
 * @property reversingUniqueId
 * @brief Unique id of transaction being reversed.
 */
@property(retain) NSString* reversingUniqueId;

/**
 * @property tradeDate
 * @brief Trade date of transaction.
 */
@property(retain) NSDate* tradeDate;

/**
 * @property settlementDate
 * @brief Settlement date; for stock splits, execution date
 */
@property(retain) NSDate* settlementDate;

/**
 * @property investment401kSource
 * @brief For 401(k) accounts, source of money used for this security.
 *
 * Must be one of the following:
 * - PRETAX 
 * - AFTERTAX 
 * - MATCH 
 * - PROFITSHARING 
 * - ROLLOVER 
 * - OTHERVEST 
 * - OTHERNONVEST
 * 
 * Default if not present is OTHERNONVEST. The following cash source types are 
 * subject to vesting: MATCH, PROFITSHARING, and OTHERVEST. 
 */
@property(retain) NSString* investment401kSource;

@end
